Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make explanations a bit more accessible and clear and improve grammar… #1424

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

sdondley
Copy link
Contributor

… and formatting

Just some fairly minor tweaks to the the first couple hundred lines of Manual.pod to improve clarity.


=item *

a script to start your appliaction in L<bin>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Application is misspelled here.

When defining a route handler for the GET method, Dancer2 automatically
defines a route handler for the HEAD method (in order to honour HEAD
requests for each of your GET route handlers).
When defining GET route hander, Dancer2 also automatically
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handler is misspelled here.

@cromedome
Copy link
Contributor

Good work! Minor changes. See my notes in the commits.

@cromedome cromedome added this to the April 2020 Release milestone Apr 13, 2020
lib/Dancer2/Manual.pod Outdated Show resolved Hide resolved
lib/Dancer2/Manual.pod Outdated Show resolved Hide resolved
@cromedome
Copy link
Contributor

I like the changes and can use them with a little more tweaking. I would be remiss in not saying that we have a new documentation branch in the works that throws out much of this manual, so if we merge this, it will not be around for the long haul.

I am grateful for the effort you have put here. Thank you!

@cromedome
Copy link
Contributor

Thanks. 👍 from me. Fellow Dancers?

@Sloth-Panda
Copy link

hey, wanted to handle this part of documentation.

@cromedome cromedome removed this from the April 2020 Release milestone Jan 12, 2021
@xsawyerx
Copy link
Member

While this can be merged as-is, it is orthogonal to the rewritten documentation available in #1069 which I am now reviewing, refreshing, and updating.

The plan is for the new documentation to entirely replace this and much of the changes described here are written differently in the new docs - while attempting to convey the same approachability.

I know this is fairly late in the process (better late than never?) but it would be best to review and apply such improvements to the new documentation. Unfortunately, it is not complete yet. However(!), there is now a clear plan and I'm making steady progress.

@sdondley would you be interested in helping review the new documentation once it is ready with the same ideas you had with these changes? You might have similar things to improve. I would greatly appreciate it.

@sdondley
Copy link
Contributor Author

Well, it's been a while since I've played with with Dancer2 but I can review it when finished and see if there are any confusing parts from the perspective of a new user.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants